//////////////////////////////////////////////////////////////////////////////////
//
// ActionScript 3.0 Common Code Library (MIT License)
// Copyright (c) 2009 AS3CommonCode | Tony Birleffi | http://www.mosaiceye.com
// 
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
// The following people are credited with originating all or parts of this code:
// FlashDoctors | flashdoctors.sourceforge.net
//
//////////////////////////////////////////////////////////////////////////////////

package org.as3commoncode.collections
{
	import org.as3commoncode.collections.IQueue;
	import org.as3commoncode.collections.IIterator;
	
	/**
	 * A queue iterator.
	 * 
	 * @see	org.as3commoncode.collections.IIterator;
	 * @author Tony Birleffi
	 */	
	public class QueueIterator implements IIterator
	{
		/** * The queue reference. */
		protected var queue:IQueue;
		
		/**
		 * Constructor.
		 * 
		 * @param queue		IQueue
		 */
		public function QueueIterator(queue:IQueue)
		{
			this.queue = queue;	
		}
		
		/**
		 * Has the next method.
		 * 
		 * @return Boolean.
		 */
		public function hasNext():Boolean
		{
			return (!queue.isEmpty());
		}	
		
		/**
		 * The next method.
		 * 
		 * @return Object.
		 */
		public function next():Object
		{
			var n:Object = queue.peek();
			queue.remove(n);
			return n;
		}
	}
}